<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>BoardGame 3000: Piece Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />

<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</script>

</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">BoardGame 3000
   &#160;<span id="projectnumber">1.0</span>
   </div>
   <div id="projectbrief">A simple board game structure</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.8.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Variables</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div>
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">Piece Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>One <a class="el" href="class_piece.html" title="One Piece on the board.">Piece</a> on the board.  
 <a href="class_piece.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_piece_8h_source.html">Piece.h</a>&gt;</code></p>

<p><a href="class_piece-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a625f521d371750bcc9c517b151985684"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_piece.html#a625f521d371750bcc9c517b151985684">Piece</a> (char symbol, int x, int y)</td></tr>
<tr class="memitem:a5d7a4f6bade94cb33b6f634de8aa7918"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_piece.html#a5d7a4f6bade94cb33b6f634de8aa7918">~Piece</a> ()</td></tr>
<tr class="memitem:abced8ed2c10f60fe904ed839296cc102"><td class="memItemLeft" align="right" valign="top">char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_piece.html#abced8ed2c10f60fe904ed839296cc102">getSymbol</a> ()</td></tr>
<tr class="memitem:a363acf6ce583b3bdece837c4283d5bc8"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_piece.html#a363acf6ce583b3bdece837c4283d5bc8">getPosX</a> ()</td></tr>
<tr class="memitem:a772ef545da71e53b82f2d8884cbc4456"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_piece.html#a772ef545da71e53b82f2d8884cbc4456">setPosX</a> (int x)</td></tr>
<tr class="memitem:ad4f38643f51863dcbd32a8a25feef1a7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4f38643f51863dcbd32a8a25feef1a7"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>getPosY</b> ()</td></tr>
<tr class="memitem:ab2ea1793b603d767ca2d6cdb71e02ccb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_piece.html#ab2ea1793b603d767ca2d6cdb71e02ccb">setPosY</a> (int y)</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a9be3180f1fb90c8c6e743fecb4e3b21a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9be3180f1fb90c8c6e743fecb4e3b21a"></a>
char&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_piece.html#a9be3180f1fb90c8c6e743fecb4e3b21a">m_symbol</a></td></tr>
<tr class="memdesc:a9be3180f1fb90c8c6e743fecb4e3b21a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Symbol for piece. <br/></td></tr>
<tr class="memitem:a73c0cf32e81eb8c05b87f332105af3c6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a73c0cf32e81eb8c05b87f332105af3c6"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_piece.html#a73c0cf32e81eb8c05b87f332105af3c6">m_xPos</a></td></tr>
<tr class="memdesc:a73c0cf32e81eb8c05b87f332105af3c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">X Coordinate. <br/></td></tr>
<tr class="memitem:af57b70e3ab692d1ff6d8a6e2646af2e7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af57b70e3ab692d1ff6d8a6e2646af2e7"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_piece.html#af57b70e3ab692d1ff6d8a6e2646af2e7">m_yPos</a></td></tr>
<tr class="memdesc:af57b70e3ab692d1ff6d8a6e2646af2e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Y Coordinate. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>One <a class="el" href="class_piece.html" title="One Piece on the board.">Piece</a> on the board. </p>
<p>This class represents one piece on the board If the pieces in your game have some kind of special behavior, your have to implement your own class which inheritates <a class="el" href="class_piece.html" title="One Piece on the board.">Piece</a> </p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a625f521d371750bcc9c517b151985684"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_piece.html#a625f521d371750bcc9c517b151985684">Piece::Piece</a> </td>
          <td>(</td>
          <td class="paramtype">char&#160;</td>
          <td class="paramname"><em>symbol</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>y</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Constructor, which initializes symbol for player, and X and Y coordinates </p>

</div>
</div>
<a class="anchor" id="a5d7a4f6bade94cb33b6f634de8aa7918"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="class_piece.html#a5d7a4f6bade94cb33b6f634de8aa7918">Piece::~Piece</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Destructor </p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a363acf6ce583b3bdece837c4283d5bc8"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="class_piece.html#a363acf6ce583b3bdece837c4283d5bc8">Piece::getPosX</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns X position </p>

</div>
</div>
<a class="anchor" id="abced8ed2c10f60fe904ed839296cc102"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char <a class="el" href="class_piece.html#abced8ed2c10f60fe904ed839296cc102">Piece::getSymbol</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the symbol for current piece </p>

</div>
</div>
<a class="anchor" id="a772ef545da71e53b82f2d8884cbc4456"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_piece.html#a772ef545da71e53b82f2d8884cbc4456">Piece::setPosX</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>x</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Takes in integer as argument and sets posX to x </p>

</div>
</div>
<a class="anchor" id="ab2ea1793b603d767ca2d6cdb71e02ccb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="class_piece.html#ab2ea1793b603d767ca2d6cdb71e02ccb">Piece::setPosY</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>y</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Takes in integer as argument and sets posY to y </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_piece_8h_source.html">Piece.h</a></li>
<li>Piece.cpp</li>
</ul>
</div><!-- contents -->


<hr class="footer"/><address class="footer"><small>
Generated on Sat May 12 2012 15:22:53 for BoardGame 3000 by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.0
</small></address>

</body>
</html>
